package com.example.springsecuritydemo.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Swagger (OpenAPI) 配置类
 * 用于配置API文档的基本信息和行为
 */
@Configuration
public class OpenAPIConfig {

    /**
     * 配置OpenAPI文档的基本信息
     * 完成配置后，您可以通过以下地址访问Swagger UI文档：
        - Swagger UI界面： http://localhost:8080/swagger-ui/index.html
        - OpenAPI JSON： http://localhost:8080/v3/api-docs
     * @return OpenAPI配置实例
     */
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("Spring Security Demo API")
                        .version("1.0.0")
                        .description("Spring Security Demo项目的API文档")
                        .termsOfService("https://example.com/terms")
                        .contact(new Contact()
                                .name("开发团队")
                                .email("team@example.com")
                                .url("https://example.com"))
                        .license(new License()
                                .name("Apache 2.0")
                                .url("https://www.apache.org/licenses/LICENSE-2.0.html")));
    }
}